Make strings in theme.json translatable #66675

d-alleyne · 2024-11-01T13:37:22Z

What?

Aspect Ratios and Shadow Presets are untranslated. The strings aren't in GlotPress.

Why?

This PR resolves the missing Aspect Ratios in #66027.

How?

By adding a symlink to theme.json in the project's root directory, strings will be extracted

Testing Instructions

Download the plugin locally.
Make POT with wp i18n make-pot ..
Inspect the generated gutenberg.pot file to confirm that the Aspect Ratio strings from theme.json are not being extracted.

N.B the shadow.presets strings are not extracted.

Testing Instructions for Keyboard

Screenshots or screencast

github-actions · 2024-11-01T13:37:38Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: d-alleyne <[email protected]>
Co-authored-by: swissspidy <[email protected]>
Co-authored-by: Mamaduka <[email protected]>
Co-authored-by: oandregal <[email protected]>
Co-authored-by: spacedmonkey <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

swissspidy · 2024-12-16T15:41:34Z

theme.json

@@ -0,0 +1 @@
+lib/theme.json


I'd actually move the file instead of adding a symlink

The lib/theme.json location was working before; why change it now?

cc @oandregal

This is explained in #66027

WP-CLI assumes that theme.json only exists in a theme, and in themes it's required to be in the root. It does not look for any other subfolders and I don't wanna change that in WP-CLI.

The Gutenberg plugin is an exception because it holds the "source of truth" for theme.json and does so in the lib folder.

I need to catch up a bit on this, but last I checked (3 years ago) it was working fine (it extracted strings from core, Gutenberg, and themes).

Yes please test it again. But the way WP-CLI works hasn't changed: https://github.com/wp-cli/i18n-command/blob/0133eb1326e7e0613315dd94c347a2a03ee6f2d4/src/ThemeJsonExtractor.php#L19-L25

I've also searched for specific strings that are only defined in theme.json. Example: "Dark grayscale" for duotone. Same result, they are not present in translate:

Gutenberg WordPress

More context: for testing, avoid using color gradients, palette, or font sizes. Some of these are also defined in the client (see) so it can give you false positives.

However, if I do the same search for WordPress core and Gutenberg, there are no strings coming from theme.json

With that current logic in WP-CLI that would be expected. As I said, it only looks for a specific location at the moment.

That change was made with the assumption that theme.json is supposed to live only in themes and in the root folder of theme. This helped avoid an issue where, when extracting strings in core, theme.json strings from all the default themes were erroneously included (because they live in wp-content.

I suppose we didn't realize at the time that wp-includes/theme.json also exists... 🤔

it sounds we haven't been extracting strings from the theme.json provided by WordPress (or Gutenberg) since 2 years ago?

Yes, you're right. Hmm we need to make some changes to WP-CLI then and to Meta (sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/cli/class-make-core-pot.php)

Closing the loop here: we're continuing the conversation at wp-cli/i18n-command#423

Mamaduka · 2024-12-17T13:29:25Z

lib/theme-i18n.json

+		"shadow": {
+			"presets": [
+				{
+					"name": "Shadow presets name"


Suggested change

"name": "Shadow presets name"

"name": "Shadow preset name"

Let's match the naming pattern

Can we perhaps use Shadow name instead? That's inline with what other presets do:

font sizes: "font size name"

colors: "color name"

aspect ratios: "aspect ratio name"

Also: these changes need to be backported to wordpress-develop so that the wp-cli uses them (see). Until then, these strings won't be picked up from anywhere.

@oandregal , I created a diff for wordpress-develop, but it instructs that the description should have a trac number. Do we have one, or do I create one?

You can use https://meta.trac.wordpress.org/ticket/7866 I've left a comment linking to this PR and the issue.

@oandregal I had created https://core.trac.wordpress.org/ticket/62728. I hope it isn't an issue.

That's good as well 👍

oandregal · 2024-12-18T17:25:40Z

@d-alleyne I think limiting the changes in this PR only to the theme-i18n.json and then preparing a similar PR for wordpress-develop would be best here. This will fast-track those changes.

The other conversation (why WordPress and Gutenberg theme.json files aren't picked up for translation) is a bit tricky and may need more investigation.

Co-authored-by: George Mamadashvili <[email protected]>

This reverts commit 42f4f5d.

…-json

oandregal · 2024-12-20T10:52:03Z

@d-alleyne are you able to prepare the corresponding PR to https://github.com/WordPress/wordpress-develop/?

You'd also need to push to this PR a new markdown file within backport-changelog/6.8 folder (see). That's the only blocker to land this PR and unblock the "verify core backport changelog" CI job.

oandregal · 2024-12-23T11:54:15Z

While reviewing the core backport PR I realized there are some other things that need fixing, so I've prepared the PR at #68243

d-alleyne added 2 commits October 31, 2024 14:42

Allow theme.json's strings to be extracted by wp-cli

42f4f5d

Add shadow presets to theme-i18n.json to make them translatable

7505e51

d-alleyne requested a review from spacedmonkey as a code owner November 1, 2024 13:37

Fix typo

a03c3aa

skorasaurus added the Internationalization (i18n) Issues or PRs related to internationalization efforts label Nov 12, 2024

swissspidy added the [Type] Enhancement A suggestion for improvement. label Dec 16, 2024

swissspidy reviewed Dec 16, 2024

View reviewed changes

swissspidy requested a review from Mamaduka December 16, 2024 15:41

Mamaduka reviewed Dec 17, 2024

View reviewed changes

oandregal mentioned this pull request Dec 19, 2024

Fix theme.json string extraction wp-cli/i18n-command#423

Closed

d-alleyne and others added 4 commits December 19, 2024 09:59

Match the naming pattern

6e9964b

Co-authored-by: George Mamadashvili <[email protected]>

Revert "Allow theme.json's strings to be extracted by wp-cli"

215a790

This reverts commit 42f4f5d.

Implement code review suggestion

8b1c87a

Merge branch 'WordPress:trunk' into fix/translatable-strings-in-theme…

76ce9ee

…-json

swissspidy approved these changes Dec 20, 2024

View reviewed changes

oandregal approved these changes Dec 20, 2024

View reviewed changes

spacedmonkey approved these changes Dec 20, 2024

View reviewed changes

oandregal mentioned this pull request Dec 20, 2024

Translatable strings from lib/theme.json are not being extracted for translation #66027

Closed

2 tasks

Add backlog file

29e08a5

d-alleyne mentioned this pull request Dec 20, 2024

Fix/translatable strings in theme json WordPress/wordpress-develop#8031

Open

oandregal merged commit b73c95d into WordPress:trunk Dec 23, 2024
63 of 64 checks passed

github-actions bot added this to the Gutenberg 20.0 milestone Dec 23, 2024

oandregal mentioned this pull request Dec 23, 2024

Add duotone and dimensions to the block level for translation #68243

Merged

oandregal added [Type] Bug An existing feature does not function as intended and removed [Type] Enhancement A suggestion for improvement. labels Dec 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make strings in theme.json translatable #66675

Make strings in theme.json translatable #66675

d-alleyne commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024 •

edited

Loading

swissspidy Dec 16, 2024

Mamaduka Dec 17, 2024

swissspidy Dec 17, 2024

oandregal Dec 18, 2024

swissspidy Dec 18, 2024

oandregal Dec 18, 2024

This comment was marked as outdated.

oandregal Dec 18, 2024

swissspidy Dec 18, 2024

oandregal Dec 19, 2024

Mamaduka Dec 17, 2024

oandregal Dec 18, 2024

oandregal Dec 18, 2024

d-alleyne Dec 20, 2024

oandregal Dec 20, 2024

d-alleyne Dec 23, 2024

oandregal Dec 23, 2024

oandregal commented Dec 18, 2024

oandregal commented Dec 20, 2024 •

edited

Loading

oandregal commented Dec 23, 2024

		@@ -0,0 +1 @@
		lib/theme.json

Make strings in theme.json translatable #66675

Make strings in theme.json translatable #66675

Conversation

d-alleyne commented Nov 1, 2024 • edited Loading

What?

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

github-actions bot commented Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oandregal commented Dec 18, 2024

oandregal commented Dec 20, 2024 • edited Loading

oandregal commented Dec 23, 2024

d-alleyne commented Nov 1, 2024 •

edited

Loading

github-actions bot commented Nov 1, 2024 •

edited

Loading

oandregal commented Dec 20, 2024 •

edited

Loading